home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 4 / Apprentice-Release4.iso / Source Code / Add-Ons / MPW / MPW noweb 2.7 / contrib / conrado / README < prev   
Encoding:
Text File  |  1995-05-30  |  1.6 KB  |  39 lines  |  [TEXT/MPS ]
  1. This is the README file for the collection of files related to d2tex.
  2. These files are:
  3.  
  4. - algoritmos.sty: 
  5. defines the 'code' environment and several other
  6. related environments (code*, algorithm, ...); the implementation is
  7. not documented and can be difficult to understand, but I have
  8. documented the main features of the environments.
  9. - d2tex:
  10. an noweb filter (written in awk) that prettyprints; for instance, 
  11.  /* this is a comment */ is replaced by \COMMENT{this is a comment}
  12.  <=                      is replaced by \le
  13.  PROCEDURE initialize    is replaced by \PROCEDURE |initialize|
  14.  
  15. this script does not parse the input; it only uses pattern-matching,
  16. but produces reasonable output if some thumb rules are followed.
  17. d2tex has a list of keywords built in.
  18.  
  19. - keywords.tex:
  20.  
  21. contains TeX macro definitions for producing keywords in boldface, 
  22. special simbols (as the boxes between guarded commands), etc.; most of
  23. the macros include indentation macros \tab and \untab; \tab is sets a
  24. tab and moves the margin tab to the right, while \untab removes a tab
  25. stop and moves to the left the margin tab. Since the 'code'
  26. environment is based upon the tabbing environment, it is useful for
  27. the keyword macros (such as \WHILE) to include these tab/untab
  28. macros. \tab and \untab can be used inside the 'code' environment when
  29. needed, for instance, to override the default indentation or to
  30. correct minor mistakes.
  31.  
  32. - hospital.nw:
  33. a weird example of the type of code that d2tex is 'able' to
  34. prettyprint; the documentation is not written in english (several
  35. paragraphs and comments in the code are written in catalan) and the
  36. code is not complete.
  37.  
  38.  
  39.